Skip to content

API Reference #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 16 commits into from
Apr 24, 2025
Merged

API Reference #163

merged 16 commits into from
Apr 24, 2025

Conversation

stevensJourney
Copy link
Contributor

@stevensJourney stevensJourney commented Apr 7, 2025 •
edited
Loading

Overview

This adds an automatically generated HTML API Reference using Dokka.

This can be served by running ./gradlew serveDokka in the repo root.

image

This is served at https://powersync-ja.github.io/powersync-kotlin/

TODOS

  • General comment cleanup
  • Add entries for Connectors module
  • Github pages publish flow
    • Update deploy branch

@stevensJourney stevensJourney changed the title WIP API Reference API Reference Apr 23, 2025
@stevensJourney stevensJourney requested a review from simolus3 April 24, 2025 07:30
@stevensJourney stevensJourney marked this pull request as ready for review April 24, 2025 07:30
simolus3
simolus3 reviewed Apr 24, 2025
View reviewed changes
Copy link
Contributor

@simolus3 simolus3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a really nice thing to have 👍

The images don't load for me locally, not sure if that's a setup issue or if it would also happen when deploying to GH pages:

grafik

I also noticed that the BuildConfig class now gets kind of ugly because it's not in a package. Do you know if that class is used across packages? I'm in favor of making it internal to hide the [root] package on the docs.

simolus3
simolus3 previously approved these changes Apr 24, 2025
View reviewed changes
Copy link
Contributor

@simolus3 simolus3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@stevensJourney stevensJourney merged commit 4ad8c0c into main Apr 24, 2025
6 checks passed
@stevensJourney stevensJourney deleted the api-ref branch April 24, 2025 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simolus3 simolus3 simolus3 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@stevensJourney @simolus3